Callbacks

This section describes the callbacks that are sent from the Sinch India Conversation API. These callbacks can contain delivery reports (about outbound messages).

A callback is a HTTP POST request with a notification made by the Sinch India Conversation API to a URI of your choosing.

The Sinch India Conversation API expects the receiving server to respond with a response code within the 2xx Success range. If no successful response is received, then the API will either schedule a retry if the error is expected to be temporary or discard the callback if the error seems permanent. The retry attempt will be made three times.

Delivery report callback A delivery report contains the status and state of each message sent through the Sinch India RBM API.

Sample DLR for "sent", "delivered" and "read" cases.

{
 "app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA",
 "accepted_time": "2023-06-13T09:48:57.319Z",
 "event_time": "2023-06-13T09:49:00.887336Z",
 "project_id": "517ccc41-7c1a-4dfe-af03-dfe804116121",
 "message_delivery_report": {
 "message_id": "01H2T2H437XD18TAFQJYBKJM4C",
 "conversation_id": "",
 "status": "DELIVERED",
 "channel_identity": {
 "channel": "RCS",
 "identity": "916284458847",
 "app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA"
 },
 "contact_id": ""
 "metadata": "",
 "processing_mode": "DISPATCH"
 },
 "message_metadata": ""
}

Sample DLR for “failed cases”

{
 "app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA",
 "accepted_time": "2023-06-13T09:49:35.922Z",
 "event_time": "2023-06-13T09:49:36.957Z",
 "project_id": "517ccc41-7c1a-4dfe-af03-dfe804116121",
 "message_delivery_report": {
 "message_id": "01H2T2J9SJBQM8B27A0CMGCNCD",
 "conversation_id": "",
 "status": "FAILED",
 "channel_identity": {
 "channel": "RCS",
 "identity": "919319304893",
 "app_id": "01H0MFFJFX0YAWYA5XG4D3MRTA"
 },
 "contact_id": "",
 "reason": {
 "code": "UNKNOWN",
 "description": "The underlying channel reported: Unknown channel error",
 "sub_code": "UNSPECIFIED_SUB_CODE"
 },
 "metadata": "",
 "processing_mode": "DISPATCH"
 },
 "message_metadata": ""
}